IRIX Base Documentation 2001 May/SGI IRIX Base Documentation 2001 May.iso/usr/share/catman/p_man/cat3/ifl_c/iflFileConfig.z/iflFileConfig

Text File | 1998-10-30 | 14.6 KB | 331 lines

iiiiffffllllFFFFiiiilllleeeeCCCCoooonnnnffffiiiigggg((((3333))))  IIIImmmmaaaaggggeeee FFFFoooorrrrmmmmaaaatttt LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll   iiiiffffllllFFFFiiiilllleeeeCCCCoooonnnnffffiiiigggg((((3333))))



NNNNAAAAMMMMEEEE
     iiiiffffllllFFFFiiiilllleeeeCCCCoooonnnnffffiiiigggg - iflFile configuration descriptor

IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
     This is a base class

HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
     #include <ifl/iflCdefs.h>

CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
     iflFileConfig describes the configuration of an iflFile; it is used with
     the iiiiffffllllFFFFiiiilllleeee::::::::ccccrrrreeeeaaaatttteeee(((()))) and iiiiffffllllFFFFoooorrrrmmmmaaaatttt::::::::aaaappppppppllllyyyyDDDDeeeeffffaaaauuuullllttttssss(((()))) calls.  The image
     and page size parameters are always expressed with conventional (x ==
     width, y == height) orientation, regardless of the value of the
     orientation parameter.

CCCCLLLLAAAASSSSSSSS MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN SSSSUUUUMMMMMMMMAAAARRRRYYYY
     CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrr

          iflFileConfig* iflFileConfigCreate(const iflSize* imagedims,
                                             iflDataType datatype (0),
                                             iflOrder dimensionorder (0),
                                             iflColorModel colormodel (0),
                                             iflOrientation orientation (0),
                                             iflCompression compression (0),
                                             const iflSize* pagedims )
          iflFileConfig* iflFileConfigFile(iflFile* file)

     GGGGeeeetttt////sssseeeetttt iiiinnnnppppuuuutttt mmmmeeeetttthhhhooooddddssss

          void iflFileConfigSetDimensions(iflFileConfig *obj, const iflSize* imagedims)
          void iflFileConfigSetDataType(iflFileConfig *obj, iflDataType datatype)
          void iflFileConfigSetOrder(iflFileConfig *obj, iflOrder dimensionorder)
          void iflFileConfigSetColorModel(iflFileConfig *obj, iflColorModel colormodel)
          void iflFileConfigSetOrientation(iflFileConfig *obj, iflOrientation orientation)
          void iflFileConfigSetCompression(iflFileConfig *obj, iflCompression compression)
          void iflFileConfigSetPageDimensions(iflFileConfig *obj,
                                              const iflSize* pagedims)
          void iflFileConfigGetDimensions(iflFileConfig *obj, iflSize* imagedims)
          const iflSize& getDimensionsPtr()
          void iflFileConfigGetSize(iflFileConfig *obj, iflSize* imagesize)
          iflDataType iflFileConfigGetDataType(iflFileConfig *obj)
          iflOrder iflFileConfigGetOrder(iflFileConfig *obj)
          iflColorModel iflFileConfigGetColorModel(iflFileConfig *obj)
          iflOrientation iflFileConfigGetOrientation(iflFileConfig *obj)
          iflCompression iflFileConfigGetCompression(iflFileConfig *obj)
          iflFileConfig* getPageDimensionsPtr()
          void iflFileConfigGetPageDimensions(iflFileConfig *obj,
                                              iflSize* pagedims)

     QQQQuuuueeeerrrryyyy mmmmeeeetttthhhhooooddddssss




                                                                        PPPPaaaaggggeeee 1111






iiiiffffllllFFFFiiiilllleeeeCCCCoooonnnnffffiiiigggg((((3333))))  IIIImmmmaaaaggggeeee FFFFoooorrrrmmmmaaaatttt LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll   iiiiffffllllFFFFiiiilllleeeeCCCCoooonnnnffffiiiigggg((((3333))))



          int iflFileConfigAreDimensionsDefaulted(iflFileConfig *obj)
          int iflFileConfigIsDataTypeDefaulted(iflFileConfig *obj)
          int iflFileConfigIsOrderDefaulted(iflFileConfig *obj)
          int iflFileConfigIsColorModelDefaulted(iflFileConfig *obj)
          int iflFileConfigIsOrientationDefaulted(iflFileConfig *obj)
          int iflFileConfigIsCompressionDefaulted(iflFileConfig *obj)
          int iflFileConfigArePageDimensionsDefaulted(iflFileConfig *obj)


FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
     iiiiffffllllFFFFiiiilllleeeeCCCCoooonnnnffffiiiigggg(((())))

          iflFileConfig* iflFileConfigCreate(const iflSize* imagedims,
                                             iflDataType datatype (0),
                                             iflOrder dimensionorder (0),
                                             iflColorModel colormodel (0),
                                             iflOrientation orientation (0),
                                             iflCompression compression (0),
                                             const iflSize* pagedims )


          This constructor creates a fully initialized iflFile configuration
          descriptor.  Defaulted attributes can be set later with the various
          set methods.

     aaaarrrreeeeDDDDiiiimmmmeeeennnnssssiiiioooonnnnssssDDDDeeeeffffaaaauuuulllltttteeeedddd(((())))

          int iflFileConfigAreDimensionsDefaulted(iflFileConfig *obj)


          This method returns true if any of the image dimensions have been
          defaulted.

     aaaarrrreeeePPPPaaaaggggeeeeDDDDiiiimmmmeeeennnnssssiiiioooonnnnssssDDDDeeeeffffaaaauuuulllltttteeeedddd(((())))

          int iflFileConfigArePageDimensionsDefaulted(iflFileConfig *obj)


          This method returns true if any of the page dimensions have been
          defaulted.

     ggggeeeettttCCCCoooolllloooorrrrMMMMooooddddeeeellll(((())))

          iflColorModel iflFileConfigGetColorModel(iflFileConfig *obj)


          This method returns the value of the color model parameter.

     ggggeeeettttCCCCoooommmmpppprrrreeeessssssssiiiioooonnnn(((())))






                                                                        PPPPaaaaggggeeee 2222






iiiiffffllllFFFFiiiilllleeeeCCCCoooonnnnffffiiiigggg((((3333))))  IIIImmmmaaaaggggeeee FFFFoooorrrrmmmmaaaatttt LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll   iiiiffffllllFFFFiiiilllleeeeCCCCoooonnnnffffiiiigggg((((3333))))



          iflCompression iflFileConfigGetCompression(iflFileConfig *obj)


          This method returns the value of the compression parameter.

     ggggeeeettttDDDDaaaattttaaaaTTTTyyyyppppeeee(((())))

          iflDataType iflFileConfigGetDataType(iflFileConfig *obj)


          This method returns the value of the data type parameter.

     ggggeeeettttDDDDiiiimmmmeeeennnnssssiiiioooonnnnssss(((())))

          void iflFileConfigGetDimensions(iflFileConfig *obj, iflSize* imagedims)


          This method returns the value of the image dimensions parameter.

     ggggeeeettttOOOOrrrrddddeeeerrrr(((())))

          iflOrder iflFileConfigGetOrder(iflFileConfig *obj)


          This method returns the value of the dimension order parameter.

     ggggeeeettttOOOOrrrriiiieeeennnnttttaaaattttiiiioooonnnn(((())))

          iflOrientation iflFileConfigGetOrientation(iflFileConfig *obj)


          This method returns the value of the orientation parameter.

     ggggeeeettttPPPPaaaaggggeeeeDDDDiiiimmmmeeeennnnssssiiiioooonnnnssss(((())))

          void iflFileConfigGetPageDimensions(iflFileConfig *obj,
                                              iflSize* pagedims)


          This method returns the value of the page dimensions parameter.

     ggggeeeettttPPPPaaaaggggeeeeSSSSiiiizzzzeeee(((())))

          This method returns the value of the page dimensions parameter.

     ggggeeeettttSSSSiiiizzzzeeee(((())))

          void iflFileConfigGetSize(iflFileConfig *obj, iflSize* imagesize)







                                                                        PPPPaaaaggggeeee 3333






iiiiffffllllFFFFiiiilllleeeeCCCCoooonnnnffffiiiigggg((((3333))))  IIIImmmmaaaaggggeeee FFFFoooorrrrmmmmaaaatttt LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll   iiiiffffllllFFFFiiiilllleeeeCCCCoooonnnnffffiiiigggg((((3333))))



          This method returns the image dimensions, transposing them if the
          orientation is transposed.

     iiiissssCCCCoooolllloooorrrrMMMMooooddddeeeellllDDDDeeeeffffaaaauuuulllltttteeeedddd(((())))

          int iflFileConfigIsColorModelDefaulted(iflFileConfig *obj)


          This method returns true if the color model parameter is defaulted.

     iiiissssCCCCoooommmmpppprrrreeeessssssssiiiioooonnnnDDDDeeeeffffaaaauuuulllltttteeeedddd(((())))

          int iflFileConfigIsCompressionDefaulted(iflFileConfig *obj)


          This method returns true if the compression parameter is defaulted.

     iiiissssDDDDaaaattttaaaaTTTTyyyyppppeeeeDDDDeeeeffffaaaauuuulllltttteeeedddd(((())))

          int iflFileConfigIsDataTypeDefaulted(iflFileConfig *obj)


          This method returns true if the data type parameter is defaulted.

     iiiissssOOOOrrrrddddeeeerrrrDDDDeeeeffffaaaauuuulllltttteeeedddd(((())))

          int iflFileConfigIsOrderDefaulted(iflFileConfig *obj)


          This method returns true if the dimension order parameter is
          defaulted.

     iiiissssOOOOrrrriiiieeeennnnttttaaaattttiiiioooonnnnDDDDeeeeffffaaaauuuulllltttteeeedddd(((())))

          int iflFileConfigIsOrientationDefaulted(iflFileConfig *obj)


          This method returns true if the orientation parameter is defaulted.

     sssseeeettttCCCCoooolllloooorrrrMMMMooooddddeeeellll(((())))

          void iflFileConfigSetColorModel(iflFileConfig *obj, iflColorModel colormodel)


          This method sets the value of the color model parameter to
          _c_o_l_o_r_m_o_d_e_l.

     sssseeeettttCCCCoooommmmpppprrrreeeessssssssiiiioooonnnn(((())))

          void iflFileConfigSetCompression(iflFileConfig *obj, iflCompression compression)





                                                                        PPPPaaaaggggeeee 4444






iiiiffffllllFFFFiiiilllleeeeCCCCoooonnnnffffiiiigggg((((3333))))  IIIImmmmaaaaggggeeee FFFFoooorrrrmmmmaaaatttt LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll   iiiiffffllllFFFFiiiilllleeeeCCCCoooonnnnffffiiiigggg((((3333))))



          This method sets the value of the compression parameter to
          _c_o_m_p_r_e_s_s_i_o_n.

     sssseeeettttDDDDaaaattttaaaaTTTTyyyyppppeeee(((())))

          void iflFileConfigSetDataType(iflFileConfig *obj, iflDataType datatype)


          This method sets the value of the data type parameter to _d_a_t_a_t_y_p_e.

     sssseeeettttDDDDiiiimmmmeeeennnnssssiiiioooonnnnssss(((())))

          void iflFileConfigSetDimensions(iflFileConfig *obj, const iflSize* imagedims)


          This method sets the value of the image dimension parameter to
          _i_m_a_g_e_d_i_m_s.

     sssseeeettttOOOOrrrrddddeeeerrrr(((())))

          void iflFileConfigSetOrder(iflFileConfig *obj, iflOrder dimensionorder)


          This method sets the value of the dimension order parameter to
          _d_i_m_e_n_s_i_o_n_o_r_d_e_r.

     sssseeeettttOOOOrrrriiiieeeennnnttttaaaattttiiiioooonnnn(((())))

          void iflFileConfigSetOrientation(iflFileConfig *obj, iflOrientation orientation)


          This method sets the value of the orientation parameter to
          _o_r_i_e_n_t_a_t_i_o_n.

     sssseeeettttPPPPaaaaggggeeeeDDDDiiiimmmmeeeennnnssssiiiioooonnnnssss(((())))

          void iflFileConfigSetPageDimensions(iflFileConfig *obj,
                                              const iflSize* pagedims)


          This method sets the value of the page dimension parameter to
          _p_a_g_e_d_i_m_s.

SSSSEEEEEEEE AAAALLLLSSSSOOOO
     iflFile(3), iflFormat(3)










                                                                        PPPPaaaaggggeeee 5555